home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr35 / ofu103.zip / README.OFU < prev   
Text File  |  1993-06-18  |  10KB  |  214 lines
  1.  
  2.  Opus Filename Updater for the Opus CBCS v1.7x/v1.8x Files Database
  3.                    Copyright 1993 by Kevin Silcox
  4.  
  5.                                                            June 18, 1993
  6.  
  7. Disclaimer
  8. ----------
  9.     This software is available "AS IS".  It is not guaranteed to work at
  10. all.  If it trashes your system or ruins your life, you have been warned.
  11. I am not responsible for any damages incurred from the use or misuse of
  12. this software.  There is also no fee to use this software to keep with
  13. the spirit of Opus.
  14.  
  15.        ***********************************************************
  16.        **** ALWAYS HAVE A RECENT BACKUP COPY OF YOUR DATABASE ****
  17.        ***********************************************************
  18.  
  19.   *************************************************************************
  20.   *     It's not a requirement to run OFARE every time you run OFU,       *
  21.   *   however you should *ALWAYS* run OFARE when you are done changing    *
  22.   *   filenames with OFU before you run Opus to prevent database          *
  23.   *   corruption. (Opus v1.7x)                                            *
  24.   *************************************************************************
  25.  
  26. ---===---
  27.     OFU allows you to automatically change filenames within the Opus
  28. Files Database via a command-line interface.  If OFU updates a filename
  29. then the file information (date/time, size) will be updated to match
  30. the new filename.  This program should be very handy for those that do
  31. automatic virus scanning of newly uploaded files, archive conversion,
  32. or when converting archives to a different format.
  33.  
  34.     OFU will automatically detect the version of files database you are
  35. using and use the correct structures.  Any structure changes made after
  36. the date of this release may cause problems with the operation of OFU.
  37. As of this release OFU works with Opus versions 1.7x, and the 1.99/1.8x
  38. beta and gamma releases.
  39.  
  40.     The files that OFU uses are the following:
  41.     (R-O) = Read-Only       (R/W) = Read/Write
  42.  
  43. (R-O)   PRM file                To locate the system files if necessary
  44. (R-O)   FILESBBS.ADX            To get valid area numbers and area
  45.                                   offsets within the database
  46. (R-O)   SYSFILE.DAT             To get default download paths
  47. (R/W)   FILESBBS.DAT            To read/update file information
  48.  
  49.     The FILESBBS.DAT file is the only one that is ever changed, and is
  50. opened in DENYWRITE share mode.  If this is an incorrect method please
  51. bring it to my attention.  Thanks.
  52. ---===---
  53.  
  54.     NOTICE:  This program will abort if it detects that Opus is
  55. currently active for the task it's processing.  If the files database
  56. is common between two or more tasks then you have to take the necessary
  57. precautions to make sure OFU doesn't run while another task is active.
  58. It is *highly* recommended that Opus is not active *at all* when running
  59. OFU since the database will need to be re-indexed (OFARE) if any filenames
  60. get changed.  See Errorlevels below.
  61.  
  62.  
  63.     The RAM requirement is based entirely on the buffer size, and the number
  64. of areas being processed (along with the download path length).  The base
  65. memory required to load OFU is somewhere around 35Kb.  Take the base value
  66. and add the following values to get the approximate RAM requirement:
  67.   - Buffer size
  68.   - Number of areas times 30 bytes.  Each area takes up 11 bytes plus the
  69.     length of the download path string (19 bytes is an approximation
  70.     for the download path string length).
  71.  
  72.     So processing 50 areas with a 4Kb buffer would require somewhere around
  73. 40Kb.  (50 * 30 + 4096 + 35840 = 41436 bytes or approximately 40Kb)
  74.  
  75. --=={*-------------------------------------------------*}==--
  76.  
  77. Errorlevels:
  78.  11: One or more filenames deleted/undeleted (run OFARE at your convenience)
  79.  10: One or more filenames changed (recommended to run OFARE immediately)
  80.   6: Error writing to file
  81.   5: Error reading file
  82.   4: Attempt to use *potential* invalid wildcard sequence
  83.   3: Current task active
  84.   2: Memory allocation error
  85.   1: Unsuccessful (General Error)
  86.   0: Nothing changed
  87.  
  88.  
  89. ------------------------------------------------------
  90. Usage:
  91.  
  92.   OFU oldName newName cmd [cmd] [...]
  93.  
  94.         When changing filename(s).
  95.  
  96.            or
  97.  
  98.   OFU Name cmd [cmd] [...]
  99.  
  100.         When using the Delete/Undelete or Clean option.
  101.  
  102.  
  103. Valid Command-line Switches (cmd):
  104.  
  105.   #       A valid area number (i.e. 1 {not the # symbol}) for
  106.         processing.
  107.  
  108.   /A      Process all areas (self explanatory).  All areas will be
  109.         searched for filename replacement.
  110.  
  111.   /B#     Multiply # by 2048 bytes (2Kb) for the memory buffer size.
  112.         This value will be used when allocating any buffer to read
  113.         data from a file (except the Area list which is determined
  114.         by the number of areas, and the size of the Download Path
  115.         strings).  The default value is 2 which uses a buffer size
  116.         of 4Kb (and should give good performance).  Valid values
  117.         are from 1 to 32.
  118.  
  119.   /C[A|Q]   Clean out MISSING filenames [All|Quick].  Any entry that is
  120.         marked MISSING in the database will be marked for deletion after
  121.         OFU confirms that the file is really missing.  If you activate
  122.         Quick mode then OFU won't verify that the file doesn't exist and
  123.         goes entirely by the flag in the database (not recommended).
  124.         This option works best after you've had OFARE process the database
  125.         since it only checks the filenames that are marked MISSING, and
  126.         not every filename in the database (for speed reasons).  If you use
  127.         the All mode then each matching filename will be checked to see if
  128.         it exists.  If it doesn't exist then it'll be marked for deletion.
  129.         You still need to specify the first filename (to match) but you can
  130.         use full wildcards.
  131.           i.e. OFU *.* /CA /A   to check each files existance and clean
  132.                                 out any missing files in all areas
  133.  
  134.   /D[U]   Delete/Undelete file(s) from database.  The first filename
  135.         listed on the command-line will be the one marked for
  136.         deletion/undeletion from the specified file area(s).  The
  137.         undelete is only useful if you just marked a file for deletion
  138.         (on accident?) and haven't re-indexed the database yet.
  139.  
  140.   /Q      Quiet mode.  Suppresses filename display.
  141.  
  142.   /R[Q][D][#]   Using /R by itself will call OFARE if any filenames have
  143.         been changed.  The 'Q' tells OFARE to do a quick update.  Adding
  144.         a 'D' after it (no space) will also call OFARE if a file has been
  145.         marked as DELETED which will physically remove the DELETED file.
  146.         Specifying a number at the end of the argument will pass that
  147.         number as a buffer setting to OFARE.  Check with the OFARE help
  148.         screen for more information on OFARE command-line options.
  149.  
  150.  
  151. ------------------------------------------------------
  152. Examples (and other information):
  153.  
  154.   OFU *.ARC *.ZIP /A
  155.  
  156.   OFU FILE1.ARC FILE1.ZIP 1 20
  157.  
  158.   OFU NODELIST.A?? NODELIST.Z?? 12 /B1
  159.  
  160.   OFU NODE*.A* *.Z* 6
  161.  
  162.   OFU NODE*.A* *.Z* 6 /RQD20
  163.  
  164.   OFU VIRUS.ZIP 1 /D
  165.  
  166. - Any valid DOS filename can be used, including the DOS wildcard
  167.   characters which should be processed the same way as DOS does.
  168.  
  169. - You can specify up to 64 areas to process on the command-line,
  170.   (if they'll fit) or OFU can process up to 4096 areas when using
  171.   the /A switch.
  172.  
  173. - Generally a small buffer size is best (especially when using /A),
  174.   unless you have exceptionally large file areas (over 200 files per
  175.   area).  You shouldn't ever need to change the buffer size from the
  176.   default value, but the option is there just in case.
  177.  
  178. - Please be careful with wildcards!  I've tried to screen out the more
  179.   dangerous combinations, but don't rely on my thinking of all possible
  180.   bad wildcard combinations.  The safest thing to do is automatically
  181.   make a backup (or archive) of your database files once a day.  That
  182.   way if something goes wrong you'll have a recent copy of the database.
  183.   If you discover a dangerous (one that makes OFU change filenames
  184.   incorrectly) wildcard combination that gets past OFU, please send me
  185.   Netmail as to the command-line and I'll try to add that combination
  186.   to the screening process.  Thank you.
  187.  
  188. ------------------------------------------------------
  189.  
  190. -={**}=-
  191.     Thank You for taking your time to read this, and use my program.
  192. If you have any comments or suggestions, I'd like to hear from you.
  193. Please contact me if you have any problems, or you would like to see
  194. any added features.  You may contact me (via NetMail) at the phone
  195. number (or Net Addresses) listed below.  I also read the NEWOPUS and
  196. MEADOW Echo's.  The latest version of my software is also available
  197. on my BBS.  It may be requested with the magic name of OFU.
  198.  
  199.                                 --=={ Kevin Silcox ------
  200.                                 SysOp of:
  201.                                     StormFront
  202.                                     in Orangevale, California
  203.                                     (916) 988-0407
  204.                                     FidoNet (1:203/407.0)
  205.                                     CalNet (49:916/407.0)
  206.  
  207.                                 BBS Hours:
  208.                                           24 hours a day,
  209.                                     excluding National Mail Hour:
  210.                                       1:00 a.m to 2:00 a.m PST
  211.  
  212.     Special Thanks to my Beta Test Team and the Opus Utility Team.
  213.  
  214.